docs: sync documentation with current API (automated) by rmad17 · Pull Request #128 · auth0/auth0-server-python

rmad17 · 2026-06-30T11:37:03Z

Summary

Automated documentation drift fix. 9 findings addressed (5 P1 · 2 P2 · 2 P3).

README.md — fix poetry install → poetry add (P1, wrong Poetry subcommand)
README.md — fix unquoted dict key redirect_uri: → "redirect_uri": (P1, Python NameError on copy-paste)
README.md — add missing store_options to login/callback route examples (P2)
examples/InteractiveLogin.md — fix import from auth_server.server_client → from auth0_server_python.auth_server.server_client (P1)
examples/InteractiveLogin.md — replace raw dict calls with StartInteractiveLoginOptions(...) in sections 2, 3, 4, 5, 6 (P1, AttributeError on copy-paste)
examples/InteractiveLogin.md — fix broken/unclosed code block in section 5 RAR example (P1, SyntaxError)
examples/ConfigureStore.md — replace start_login()/complete_login() with start_interactive_login()/complete_interactive_login() (P2, wrong method names for ServerClient)
examples/RetrievingData.md — remove trailing semicolons from Python code examples (P3)
examples/RetrievingData.md — fix loginHint → login_hint in option description (P3)

Full Drift Report

#	Severity	File	Issue
1	P1	`README.md`	`poetry install auth0-server-python` is wrong — should be `poetry add`
2	P1	`README.md`	Unquoted dict key `redirect_uri:` causes `NameError` in Python
3	P1	`examples/InteractiveLogin.md`	Wrong import: `from auth_server.server_client` missing package prefix
4	P1	`examples/InteractiveLogin.md`	`start_interactive_login({...})` with raw dict causes `AttributeError` — must use `StartInteractiveLoginOptions`
5	P1	`examples/InteractiveLogin.md`	Unclosed brace in section 5 RAR code block causes `SyntaxError`
6	P2	`examples/ConfigureStore.md`	`start_login()`/`complete_login()` are `auth0-fastapi` wrapper names, not `ServerClient` methods
7	P2	`README.md`	Login/callback examples omit `store_options` — silently breaks cookie-based stores
8	P3	`examples/RetrievingData.md`	Trailing semicolons on `get_user();` and `get_session();`
9	P3	`examples/RetrievingData.md`	`loginHint` should be `login_hint` (snake_case)

🤖 Generated with syncing-docs skill

…e_options in login examples

…ions, fix broken code block

…thod names

…to login_hint

rmad17 added 4 commits June 30, 2026 16:59

docs: fix poetry install command, unquoted dict key, and missing stor…

ce786ed

…e_options in login examples

docs: fix import path, replace raw dict with StartInteractiveLoginOpt…

4f7ffc3

…ions, fix broken code block

docs: replace start_login/complete_login with correct ServerClient me…

af32ea9

…thod names

docs: remove trailing semicolons from Python examples, fix loginHint …

bbbb63f

…to login_hint

rmad17 requested a review from a team as a code owner June 30, 2026 11:37

rmad17 closed this Jul 1, 2026